Get Shipment Details API:
Description: Use this API to Get Shipment Details.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| URL: | https://api.rapidshyp.com/session/shipment/fetch_shipment_details_with_shipmetId?auto_increment_id=S2610346100 |
| Request Type: | GET |
| Scheme: | HTTPS |
| Header (accept): | application/json, text/plain, */* |
| Header (authorization): | Bearer <YOUR_TOKEN> |
Curl:
curl --url 'https://api.rapidshyp.com/session/shipment/fetch_shipment_details_with_shipmetId?auto_increment_id=S2610346100' -H 'accept: application/json, text/plain, */*' -H 'accept-language: en-US,en;q=0.9' -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOnsiJG9pZCI6IjY2OTc0YjM0NGFhNTc4OTI5MDEwMDIzOCJ9LCJwYXJlbnRfaWQiOnsiJG9pZCI6IjY2OTc0YjM0NGFhNTc4OTI5MDEwMDIzOCJ9LCJtaWRkbGVfbmFtZSI6IiIsImZpcnN0X25hbWUiOiJUZXN0aW5nIiwibGFzdF9uYW1lIjoiIiwiZW1haWwiOiJhdmRoZXNoLmJoYXJkd2FqQG9tbG9naXN0aWNzLmNvLmluIiwic2VsbGVyX2NvZGUiOiIyNDAwMDI0MyIsImRwIjoiIiwic2Vzc2lvbl90aW1lIjoxNzkwODMxODY1MzgwLCJleHAiOjE4NzcyMzE4NjUsInNlbGxlcl9hZG1pbiI6dHJ1ZSwiY3VycmVudF9zdGF0ZSI6IkNPTVBMRVRFRCIsIm11bHRpX2ZhY3Rvcl90eXBlIjoiZW1haWwiLCJjdXJyZW5jeSI6IklOUiIsImt5Y19zdGF0dXMiOiJDT01QTEVURUQiLCJhZ3JlZW1lbnRfYWNjZXB0ZWQiOnRydWUsInRlbmFudF9pZCI6MSwidXNlcl90eXBlIjoiV0VCX1VTRVIiLCJwcmltYXJ5X21vYmlsZSI6Ijk0NDQ1NTY3ODciLCJpd29ya2JlbmNoX2lkIjoiIiwic2Vzc2lvbklkIjoiZTRmZmRiMDgtYzdkNC00Y2M2LWI5OTAtYzQ1ZDdmYmU5OTI4In0.2oex_PjGuHYjapPqLxN8ueXeUPGfmHWAgvc4u76dgiI' -H 'origin: https://app.rapidshyp.com' -H 'priority: u=1, i' -H 'referer: https://app.rapidshyp.com/' -H 'sec-ch-ua: "Not=A?Brand";v="99", "Google Chrome";v="151", "Chromium";v="151"' -H 'sec-ch-ua-mobile: ?0' -H 'sec-ch-ua-platform: "macOS"' -H 'sec-fetch-dest: empty' -H 'sec-fetch-mode: cors' -H 'sec-fetch-site: same-site' -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/151.0.0.0 Safari/537.36'
| Request Parameters | Required | Remark | Validation |
|---|---|---|---|
| auto_increment_id | Mandatory | Shipment auto increment ID (e.g. S2610346100) | Valid shipment auto increment ID |
Response:
JSON
{
"status": true,
"msg": null,
"total_records": 1,
"records": [
{
"_id": "6ad0b4b29089738d0bd6da7b",
"shipment_auto_increment_id": "S2610346100",
"order_auto_increment_id": "O261060",
"order_id": "6ad0b4a5ff02cfe60e2e46c1",
"seller_order_id": "SMOKE_TEST_KL",
"shipping_name": "Auto Customer",
"shipping_email": "prod.automate@yopmail.com",
"shipping_contact": "919999999880",
"shipping_pin_code": "110001",
"seller_pin_code": "110001",
"order_lines": [
{
"name": "API Automation Order Product",
"sku": "API-AUTO-SKU-D85B1147",
"units": 2,
"unit_price": 250.0,
"selling_price": 500.0
}
],
"shipment_tracking": [],
"shipment_transition": [
{
"entity_id": "S2610346100",
"old_status": "ASSIGNED",
"new_status": "ASSIGNED",
"created_on": 1792062642356,
"entity_type": "SHIPMENT_ORDER",
"created_by": "Testing"
},
{
"entity_id": "S2610346100",
"old_status": "CREATED",
"new_status": "CREATED",
"created_on": 1792062642356,
"entity_type": "SHIPMENT",
"created_by": "Testing"
}
],
"payment_method": "PREPAID",
"sub_total": 500.0,
"total_order_value": 500.0,
"shipment_creation_date": 1792062642284,
"length": 10.0,
"breadth": 10.0,
"height": 10.0,
"weight": 0.5,
"shipment_id": "6ad0b4b29089738d0bd6da7b",
"last_update_date": 1792062642284,
"shipment_order_status": "CREATED",
"shipment_tracking_status": null,
"shipment_order_number": null,
"channel_data": {
"store_name": "DEFAULT",
"channel_logo_url": "https://storage.googleapis.com/rapidshyp-live/channel_images/Custom.svg",
"channel_name": null
},
"awb": "",
"courier_name": null,
"manifest_id": null,
"seller_address": "123 Main St",
"seller_address2": "",
"seller_city": "NEW DELHI",
"seller_state": "DELHI",
"shipping_address": "H.No. 94, Bhat Path",
"shipping_address2": "",
"shipping_city": "NEW DELHI",
"shipping_state": "DELHI",
"applied_weight": null,
"market_place_order_id": "O261060",
"volumetric_weight": null,
"shipping_charges": 0.0,
"total_discount": 0.0,
"transaction_charges": 0.0,
"gift_wrap_charges": 0.0,
"total_prepaid_amount": 0.0,
"collectable_amount": 0.0,
"rto_state": "DELHI",
"rto_pin_code": "110001",
"rto_city": "NEW DELHI",
"rto_address": "123 Main St",
"order_creation_date": 1792062321000,
"tags": [],
"note": null,
"status_code": null,
"pod_url": null,
"rto_address_2": "",
"is_hazmat": false,
"is_restricted": false,
"is_secured": null,
"insurance_charges": null,
"insurance_gst_charges": null,
"otp_based_delivery": null,
"pickup_address_name": "DelheiTT",
"pickup_seller_name": "AvdheTsht",
"pickup_seller_email": "john.doe@example.com",
"pickup_seller_contact": "7302907766",
"rto_address_name": null,
"rto_address_contact": "7302907766",
"applied_package_rule": "",
"assignment_rule_applied": null,
"assignment_priority_applied": null,
"is_high_value_order_media_uploaded": false,
"high_value_order_media": null,
"is_scan_to_record_synced": false,
"scan_to_record_synced_details": [
{
"logo_url": null,
"package_video_duration": null,
"video_size": null,
"package_video_url": null
}
],
"package_images": null,
"e_way_bill_no": "",
"eway_expiry_date": 0,
"ewaybill_required": false
}
]
}